Release 10.1A: OpenEdge Development:
Progress Dynamics Managers API Reference

setProfileData

This procedure sets profile data values for the specified profile for the current user in the current session. You can use this procedure to set values or to delete a single record. Alternately, by using blank as the value for the pcProfileCode and pcProfileDataKey parameters, you can set a value for all records or delete all records.

If a rowid is passed in, then the record to set is found using the rowid, rather than using the individual profile fields. The record must already exist to be set in this way. For a client-only profile type, the rowid of the temp-table is used. Otherwise, the rowid of the database record is used. A profile type is passed in with the rowid to indicate whether it is from the temp-table of the database. If a rowid is passed in, it takes precedence over any other input parameters.

When the client cache is updated, the build cache external procedure must be run to fully build the temp-table with entries for this profile type for the current user. This ensures that entries are either updated fully into the cache or the database. This behavior also ensures that a record exists for the user for every profile code in the profile type. In this way, all the information needed to create new records in the cache is available, for example, the object numbers.

Location: af\app\afpromngrp.i

Parameters:

INPUT pcProfileTypeCode AS CHARACTER

The profile type code.

INPUT pcProfileCode AS CHARACTER

The profile code, (blank = all).

INPUT pcProfileDataKey AS CHARACTER

The profile data key, (blank = all).

INPUT prRowid AS ROWID

The rowid of profile data, if known.

INPUT pcProfileDataValue AS CHARACTER

The profile data value.

INPUT plDeleteFlag AS LOGICAL

The delete flag (YES = delete profile data).

INPUT pcSaveFlag AS CHARACTER

The save flag (SES = Session only, PER = Permanent).

Notes:

If the procedure runs on the client and the profile type is client-only, the procedure only updates the client cache with the new data value. The database is updated at session end or can be manually updated using updateCacheToDb.
If the procedure runs on the server or the profile type is server, the procedure updates the database immediately with the new profile data value.
If the pcSaveFlag flag is set to session, the procedure stores the session ID in the context ID field. Leaving the field blank indicates a permanent value.
If the plDeleteFlag flag is set to YES and client caching is valid, the procedure marks the data value for deletion in the temp-table. Otherwise, the data value is deleted directly from the database table.
Examples: See the setUserProfile procedure in af\cod\afsvwizdw.w.